/**
 * Copyright 2010-2011 initialize4j.org
 * 
 * <pre>
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * </pre>
 * 
 * <pre>
 * http://www.apache.org/licenses/LICENSE-2.0
 * </pre>
 * 
 * <pre>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 * </pre>
 */
package org.initialize4j;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.apache.commons.beanutils.Converter;
import org.initialize4j.convert.NullConverter;
import org.initialize4j.provide.NullProvider;
import org.initialize4j.provide.Provider;

/**
 * Common annotation for configuring initialize4j.
 * 
 * @author <a href="hillger.t@gmail.com">hillger.t</a>
 */
@Target(value = ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Initialize {
  
  /**
   * Returns the {@link Usage} type to use. Defaults to {@link Usage#CONVERTER}.
   * 
   * @return
   */
  Usage use() default Usage.CONVERTER;

  /**
   * Returns the value to initialize.
   * 
   * @return
   */
  String value() default "null";
  
  /**
   * The {@link Converter} class to use - defaults to {@link NullConverter}.
   * 
   * @return
   */
  Class<? extends Converter> converter() default NullConverter.class;

  /**
   * Returns the {@link Provider} to use - defaults to {@link NullProvider}.
   * 
   * @return
   */
  Class<? extends Provider<?>> provider() default NullProvider.class;
  
  /**
   * Array of scope names which should be considered when initializing a bean.
   * 
   * @return
   */
  String[] scope() default {};
}
